Patch Downloads

The Patch Downloads method enables you to find patch download information, download patches and delete patches by their download ID.

Base URL

        https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads

URL Parameters

 

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID of patch}

URL Parameters

 

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID of patch}/InvariantCulture

 

  

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID of patch}/{culture of patch}

 

 

GET

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads

URL Parameters

PatchDownload[]

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID of patch}

URL Parameters

PatchDownload[]

POST

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/scans/{ID}

 

The operation location URI.

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/{ID}

URL Parameters

 

Input Model

Name Type Description

count

Integer

Provide the count of items to return. The default is 10 and the maximum value is 1000.

culture

String

Specifies the language culture name. Valid values are:

  • "Universal Installer (one file for all languages)"

    • If you omit the culture parameter and allow it to default, the Universal Installer will be used.

  • Any valid IEFT standard language tag (for example: en-US, de-DE, etc.)

Tip: The list of supported language cultures for a patch can be determined by using the GET method and omitting the culture parameter.

errorPolicy

Enum

Determines if the call will throw an error when encountering an invalid ID.

  • ErrorPolicy=Throw means the entire request will be rejected.
  • ErrorPolicy=Omit means the problem area will be omitted but the rest of the request will be completed. Omit is the default value.

ids

String

Specifies the patch IDs.

start

Guid

Sets the starting point. The items are sorted by their unique identifier and the starting point is the index into that sorted list.

Example with Sample Response

Find patch download information for the first 2 patches for culture en-US

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/?count=2&culture=en-US

Sample Response

Copy 
{
    "count": 2,
    "links": {
        "next": {
            "href": "https://device-name.example.com:3121/st/console/api/v1.0/patch/downloads?count=2&start=000000ba-0000-0000-0000-000000000000"
        }
    },
    "value": [
        {
            "cultureName": "en-US",
            "downloaded": false,
            "downloadMethod": "Unavailable",
            "links": {
                "self": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/patch/downloads/00000042-0000-0000-0000-000000000000?culture=en-US"
                }
            },
            "patchId": "00000042-0000-0000-0000-000000000000"
        },
        {
            "cultureName": "en-US",
            "downloaded": false,
            "downloadMethod": "Automatic",
            "fileName": "Q274303 _WMP70_Gold_x86_ENU.exe",
            "filePath": "C:\\ProgramData\\LANDESK\\Shavlik Protect\\Console\\Patches\\Q274303 _WMP70_Gold_x86_ENU.exe",
            "fileSize": 267792,
            "links": {
                "self": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/patch/downloads/00000093-0000-0000-0000-000000000000?culture=en-US"
                }
            },
            "patchId": "00000093-0000-0000-0000-000000000000"
        }
    ]
}

Other Request Examples

DELETE Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/000000ba-0000-0000-0000-000000000000?culture=en-US

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/000000ba-0000-0000-0000-000000000000?culture=en-US

POST Request

https://<consoleFQDN:port>/st/console/api/v1.0/patch/downloads/scans/01234567-89AB-CDEF-0123-456789ABCDEF

Output Model

Name Type Description

cultureName

String

The language culture name.

downloaded

Boolean

Specifies if the patch has been downloaded.

downloadMethod

 

The method used to download the patch.

fileName

String

The base file name.

filePath

String

The location of the patch file on the console machine.

fileSize

Int64

The file size.

links

Links

Shows the related URL for the patch.

patchId

Guid

The unique identifier that was automatically assigned to the patch.